# -*- coding: utf-8 -*-
# @Time    : 2024/7/24 14:00
# @Author  : yujiahao
# @File    : 58_fastapi_change_code.py
# @description:响应-更改状态码


"""
使用场景
例如，假设你想默认返回一个 HTTP 状态码为 "OK" 200。

但如果数据不存在，你想创建它，并返回一个 HTTP 状态码为 "CREATED" 201。

但你仍然希望能够使用 response_model 过滤和转换你返回的数据。

对于这些情况，你可以使用一个 Response 参数。
"""

from fastapi import FastAPI, Response, status

app = FastAPI()

tasks = {"foo": "Listen to the Bar Fighters"}


# 使用 Response 参数

# 你可以在你的路径操作函数中声明一个Response类型的参数（就像你可以为cookies和头部做的那样）。
# 然后你可以在这个临时响应对象中设置status_code。
# todo  本质上，这段代码确实是通过操作响应对象 response 来根据条件设置不同的 HTTP 状态码。

@app.put("/get-or-create-task/{task_id}", status_code=200)
def get_or_create_task(task_id: str, response: Response):

    """
    然后你可以像平常一样返回任何你需要的对象（例如一个 dict 或者一个数据库模型）。
    如果你声明了一个 response_model，它仍然会被用来过滤和转换你返回的对象。

    FastAPI 将使用这个临时响应来提取状态码（也包括 cookies 和头部），并将它们放入包含你返回的值的最终响应中，
    该响应由任何 response_model 过滤。

    你也可以在依赖项中声明 Response 参数，并在其中设置状态码。但请注意，最后设置的状态码将会生效。
    """

    if task_id not in tasks:
        tasks[task_id] = "This didn't exist before"
        response.status_code = status.HTTP_201_CREATED
    return tasks[task_id]
